CxFmsConfigCtrl Properties

The CxFmsConfigCtrl object contains the following properties.

General Properties

Browse by letter:     [A]     [B]     [C]     [D]     [E]     [F]     [I]     [P]     [S]     [U]    

Property SubType Read Only Description

Appearance

Integer

No

Returns/sets the appearance of the object boundary. Possible values for this property are as follows.

  • 0 – Flat
  • 1 – 3D

Default value is 0 - Flat.

BeginDate

String

No

Note: This property is only used if the UseSessionOptions property is set to 0 - No.

Returns/sets the starting date of the FMS Configuration control.

This string can be in one of the following forms.

  • Absolute date - for example: 1/31/2023
  • Relative date - for example: T (today), T-14 (14 days prior to today), or T+1 (one day following today)

Default value is T-7.

See Selecting Date and Time for more information.

BorderStyle

Integer

No

Returns/sets the border style. Possible values for this property are as follows.

  • 0 - None
  • 1 - Fixed single border

Default value is 0 - None.

ChooserFilterString

String

No

Returns/sets the filter to be used, of the type specified by the ChooserFilterType property, when retrieving Nodes for selection.

Wildcard values * (multiple character) and ? (single character) are supported. Wildcards can be used in any part of the string to specify that any character or set of characters is allowed in its place.

Example

A filter string of "*Test*" will retrieve all Nodes with the word "Test" somewhere in the string, such as "TestDevice" or "MyTestDevice" or "Device001Test".

Default value is * (multiple character wildcard).

ChooserFilterType

Integer

No

Returns/sets the Node property type that will be filtered by the string specified in the ChooserFilterString property. Possible values for this property are as follows.

  • 0 – Name
  • 1 – Description
  • 2 – ID

Default value is 0 - Name.

ChooserGroupSelection

String

No

Returns/sets the group currently selected in the Node chooser’s Group combo box

ChooserNodeCategorySelection

Integer

No

Returns/sets the Node category currently selected in the Node chooser’s Node category combo box

Possible values for this property are as follows.

  • 1 – Node_Category5_Device
  • 8 – Node_Category5_Gas_Device
  • 9 – Node_Category5_Liquid_Device

Default value is 1 - Node_Category5_Device.

ChooserNodeCategoryVisible

Boolean

No

Returns/sets whether or not the Node chooser’s Node category combo box is visible

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes.

ChooserPrimarySortColumn

Integer

No

Returns/sets the primary sort column of the Node chooser’s Node list. Possible values for this property are as follows.

  • 0 - Type ascending
  • 2 - Name ascending
  • 3 - Description ascending
  • 4 - Type descending
  • 5 - Name descending
  • 6 - Description descending

Default value is 2 - Name ascending.

ChooserSiteServiceSelection

String

No

Returns/sets the Site.Service currently selected in the Node chooser’s FMS combo box.

ChooserSiteServiceVisible

Boolean

No

Returns/sets whether or not the Node chooser’s FMS combo box is visible. Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes.

CmdDefinitionXml

String

No

Returns/sets the XML specifying the custom FMS commands configured for the control. Another way to configure this property is to use the control’s property page.

ColumnsXml

String

No

Returns/sets the XML specifying the columns that will be displayed in the FMS Configuration control, for either data view.

Another way to configure this property is to use the control-specific property page in the CygNet FMS Control Properties dialog box. See CygNet FMS Configuration Control for more information.

DataView Integer No

Returns/sets the type of data view shown in the FMS Configuration control. Possible values for this property are as follows.

  • 0 – Configuration
  • 1 – Gas Analysis

Default value is 0 - Configuration.

DateFormat

Integer

No

Note: This property is only used if the UseSessionOptions property is set to 0 - No.

Returns/sets the format of the dates shown in the FMS Configuration control. Possible values for this property are as follows.

  • 0 – Device time
  • 1 – Contract time
  • 2 – Local time

Default value is 0 - Device time .

DecimalPrecision

Integer

No

Returns/sets the number of decimal places that will be shown in the values displayed by the FMS Configuration control. Acceptable values include 0 -10 decimal places. Default value is 7.

EndDate

String

No

Note: This property is only used if the UseSessionOptions property is set to 0 - No.

Returns/sets the ending date of the FMS Configuration control. This string can be in one of the following forms.

  • Absolute date - for example: 1/31/2023
  • Relative date - for example: T (today), T-14 (14 days prior to today), or T+1 (one day following today)

Default value is T.

See Selecting Date and Time for more information.

FilterConfigXml

String

No

Returns/sets the XML string specifying the filter settings to use for data display in the FMS Configuration control. Filter property options correspond to data view selection. See Configure Filter in the Using the Configuration Control topic for more information about available filter settings corresponding to each data view.

In Configuration data view, when DataView = 0 - Data_View_Config, possible values are as follows.

Data sources to show:

  • 1 – Device

  • 2 – Imported

  • 3 – Device File

  • 8 – Event Generated

  • 9 – System Generated

  • 10 – User Entered

  • 11– Linked Gas Quality

  • 14– User File

  • 255 – Any

Default value is 255 - Any.

In Gas analysis data view, when DataView = 1 - Data_View_Gas_Analysis possible values are as follows.

Data sources to show:

  • 9 – System Generated
  • 10 – User Entered
  • 11– Linked Gas Quality
  • 14– User File
  • 255 – Any

Default value is 255 - Any.

Status to show:

  • Pending - record is available to be sent
  • Sent - record has been sent
  • Failed - send action has failed
  • Timeout - send action has timed out
  • Review - record has exceptions and is awaiting Approve/Reject action
  • Rejected - record under Review was rejected

Default is all source/status values selected.

Another way to configure this property is to use the OCX Properties dialog box (Configuration page). 

Font

StdFont

No

Returns/sets the font used by the FMS Configuration control. Click to access the Font dialog box to make font selections. Default value is MS Shell Dlg.

IsEditing

Boolean

Yes

Returns whether or not the user is currently editing data in the FMS Configuration control.

PITDateTime

String

No

Note: This property is only used if the UsePIT property is set to 1 - Yes.

Returns/sets the Point in Time date and time of the FMS Configuration control. This string can be in one of the following forms.

  • Absolute Date/Time - for example: 1/31/2023 7:10:14 AM)
  • Relative Date/Time - for example: y-1 m-2 d=15 H=5 M=30 S=0)
  • Relative Day - an offset from the current day T, for example: T-10

Default value is T, date and time today.

See Using the Home Menu for more information about PIT mode.

SessionBeginDate

String

No

Note: This property is only used if the UseSessionOptions property is set to 1 - Yes.

Returns/sets the Session starting date for the time window displayed in the control. This string can be in one of the following forms.

  • Absolute date - for example: 1/31/2023
  • Relative date - for example: T (today), T-14 (14 days prior to today), or T+1 (one day following today)

See Selecting Date and Time for more information.

Note: Because Session options are universal to all FMS controls, this property can only be set via script during runtime, and the value is not saved to the control.

SessionDateFormat

Integer

No

Note: This property is only used if the UseSessionOptions property is set to 1 - Yes.

Returns/sets the Session date/time format for the time window displayed in the control. Possible values for this property are as follows.

  • 0 – Device time
  • 1 – Contract time
  • 2 – Local time

Note: Because Session options are universal to all FMS controls, this property can only be set via script during runtime, and the value is not saved to the control.

SessionEndDate

String

No

Note: This property is only used if the UseSessionOptions property is set to 1 - Yes.

Returns/sets the Session ending date for the time window displayed in the control. This string can be in one of the following forms.

  • Absolute date - for example: 1/31/2023
  • Relative date - for example: T (today), T-14 (14 days prior to today), or T+1 (one day following today)

See Selecting Date and Time for more information.

Note: Because Session options are universal to all FMS controls, this property can only be set via script during runtime, and the value is not saved to the control.

SessionNodeTag

String

No

Note: This property is only used if the UseSessionNode property is set to 1 - Yes.

Returns/sets the Session Node tag, which specifies the active Node in the FMS Configuration control. This tag must be in the form SITE.SERVICE|ID (for example, TEST.FMS|2540).

Note: Because Session options are universal to all FMS controls, this property can only be set via script during runtime, and the value is not saved to the control.

ShadingBackColor

OLE_COLOR

No

Returns/sets the color of the cells in the control. Click to access or change color configuration.

See Context Menu for the selected data view for more information about this property.

Default value is 255.250.205 (pale yellow)

ShadingForeColor

OLE_COLOR

No

Returns/sets the color of the text in the control. Click to access or change color configuration.

See Context Menu for the selected data view for more information about this property.

Default value is 0.0.0 (black).

ShowChooserPane

Boolean

No

Returns/sets whether or not the Chooser pane will be displayed in the control. Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes.

ShowOptionsPane

Boolean

No

Returns/sets whether or not the Options pane will be displayed in the control. Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes.

ShowShading Integer No

Returns/sets which parts of the cells will be shaded with color as defined by ShadingBackColor and ShadingForeColor. Possible values for this property are as follows.

  • 0 - None
  • 1 - Foreground (text)
  • 2 - Background (cell)
  • 3 - Both

Default value is 3 - Both, shade both text and cell.

See Context Menu for the selected data view for more information about this property.

UnitSet

String

No

Returns/sets the unit set used to determine the units of each FMS data item in the FMS Configuration control. Another way to configure this property is to use either the control’s property page or to use the Options pane. Default value is the <Default> unit set, or as configured

UseFilterConfig Boolean No

Returns/sets whether or not to use the configured filter values (FilterConfigXml) to determine what data to display in the control. Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 0 - No.

UsePIT

Boolean

No

Returns/sets whether or not the PITDateTime property will be used. Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 0 - No.

UseSessionNode

Boolean

No

Returns/sets whether to use the SessionNodeTag property [if set to 1 - Yes] or to present a Chooser page for Node selection [if set to 0 - No] to specify the active Node in the control. Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes for this control.

Note: Default value varies by control type.

UseSessionOptions

Boolean

No

Returns/sets whether to use the SessionBeginDate, SessionEndDate, and SessionDateFormat properties [if set to 1 - Yes] in place of the BeginDate, EndDate, and DateFormat properties [if set to 0 - No]. Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes for this control.

Note: Default value varies by control type.

Back to top